🚀 [Feature]: Add PR Title and Description as Configurable Release Notes#264
Merged
MariusStorhaug merged 20 commits intomainfrom Jan 20, 2026
Merged
🚀 [Feature]: Add PR Title and Description as Configurable Release Notes#264MariusStorhaug merged 20 commits intomainfrom
MariusStorhaug merged 20 commits intomainfrom
Conversation
…d notes in Publish-Module workflow
Contributor
There was a problem hiding this comment.
Pull request overview
This PR adds three new configurable settings for release notes generation based on pull request metadata, aligning with the Auto-Release pattern. The changes enable users to customize whether the PR title is used as the release name, whether the PR body becomes the release notes content, and whether the PR title appears as a heading above the body.
Changes:
- Added three new boolean settings to the
Publish.Moduleconfiguration section - Updated the workflow to pass these settings to the Publish-PSModule action
- Documented the new settings in the README configuration table and defaults example
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| README.md | Adds documentation for three new Publish.Module settings (UsePRTitleAsReleaseName, UsePRBodyAsReleaseNotes, UsePRTitleAsNotesHeading) in both the configuration table and defaults YAML example |
| .github/workflows/Publish-Module.yml | Passes the three new settings from the configuration to the Publish-PSModule action |
MariusStorhaug
changed the title
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
MariusStorhaug
changed the title
…ion tags for Get-Settings and Publish-Module
… and add ReleaseType input
… updating PSResourceGet in Publish-Module workflow
Contributor
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 5 out of 5 changed files in this pull request and generated no new comments.
Comments suppressed due to low confidence (1)
.github/workflows/Publish-Module.yml:38
- The artifact download and PSResourceGet update steps have been removed, but the workflow still references
ModulePath: outputs/moduleon line 38. Without downloading the module artifact first, theoutputs/moduledirectory will not exist, causing the publish step to fail. These removed steps appear necessary for the workflow to function correctly.
- name: Publish module
uses: PSModule/Publish-PSModule@feature/releasetype-input
env:
GH_TOKEN: ${{ github.token }}
with:
Name: ${{ fromJson(inputs.Settings).Name }}
ModulePath: outputs/module
Contributor
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 10 out of 10 changed files in this pull request and generated no new comments.
Comments suppressed due to low confidence (1)
.github/workflows/Publish-Module.yml:38
- The Publish-Module workflow references 'ModulePath: outputs/module' but no longer downloads the module artifact, and there is no direct dependency on Build-Module in the workflow.yml file. While Build-Module is indirectly a dependency through Build-Site -> Build-Docs -> Build-Module, this creates a fragile dependency chain. If Build-Site or Build-Docs are skipped (which is allowed per the Publish-Module conditions), the module artifact may not exist when this action tries to access it. Consider either: (1) adding Build-Module as an explicit dependency in workflow.yml's Publish-Module job, or (2) documenting that the new Publish-PSModule@v2.2.0 action handles artifact downloading internally and no longer requires the artifact to be pre-downloaded.
- name: Publish module
uses: PSModule/Publish-PSModule@e1b338d1266dee28c6d6218756979597c8a77b7a # v2.2.0
env:
GH_TOKEN: ${{ github.token }}
with:
Name: ${{ fromJson(inputs.Settings).Name }}
ModulePath: outputs/module
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Your pull request title and description are now automatically used as release notes when publishing modules. By default, merging a PR creates a GitHub release with your PR title as a heading and your PR description as the release notes content. Additionally, when a PR is closed without merging, the workflow now automatically cleans up any prerelease versions and tags, preventing orphaned prereleases in the PowerShell Gallery.
PR-based release notes are now the default
Release notes are now automatically generated from your pull request content. When you merge a PR, the workflow creates a GitHub release with:
# Add retry logic (#123))No configuration needed—just write meaningful PR descriptions and they become your release notes.
Customizing release notes behavior
Three settings in
PSModule.ymlcontrol this behavior:Publish.Module.UsePRTitleAsReleaseNamefalsePublish.Module.UsePRBodyAsReleaseNotestruePublish.Module.UsePRTitleAsNotesHeadingtrueTo disable PR-based release notes and use GitHub's auto-generated notes instead:
Abandoned PR cleanup
When a PR is closed without merging (abandoned), the workflow now:
This saves CI resources and ensures abandoned work doesn't leave orphaned prereleases. Controlled by
Publish.Module.AutoCleanup(enabled by default).Action version pinning
All GitHub Actions references now use commit SHAs with version comments for improved security and reproducibility:
actions/configure-pages@983d7736d9b0ae728b81ab479565c72886d7745b # v5.0.0actions/deploy-pages@d6db90164ac5ed86f2b6aed7e0febac5b3c0c03e # v4.0.5PSModule/GitHub-Script@2010983167dc7a41bcd84cb88e698ec18eccb7ca # v1.7.8PSModule/Publish-PSModule@e1b338d1266dee28c6d6218756979597c8a77b7a # v2.2.0PSModule/Get-PSModuleSettings@28c1805d689dc5bfcfba7489e76c34a6d33d7da8 # v1.4.0